﻿// Licensed to the Apache Software Foundation (ASF) under one or more
// contributor license agreements.  See the NOTICE file distributed with
// this work for additional information regarding copyright ownership.
// The ASF licenses this file to You under the Apache License, Version 2.0
// (the "License"); you may not use this file except in compliance with
// the License.  You may obtain a copy of the License at
//
//      http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
namespace Math3.exception.util
{
    /// <summary>
    /// Interface for accessing the context data structure stored in Commons Math
    /// exceptions.
    /// </summary>
    public interface ExceptionContextProvider
    {
        /// <summary>
        /// Gets a reference to the "rich context" data structure that allows to
        /// customize error messages and store key, value pairs in exceptions.
        /// </summary>
        /// <returns>a reference to the exception context.</returns>
        ExceptionContext getContext();
    }
}
